Iterator 和 for...of 循环

1. Iterator 的概念

ES6 中有 Array Object Set 和 Map 四种数据集合，需要有统一的机制来遍历，遍历器就是这个统一的机制，为不同的数据结构提供统一的访问机制。

Iterator 的作用：

一是为各种数据结构，提供一个统一的、简便的访问接口；

二是使得数据结构的成员能够按某种次序排列；

三是 ES6 创造了一种新的遍历命令 for...of 循环，Iterator 接口主要供 for...of 消费。

Iterator 遍历过程：

创建一个指针对象，指向当前数据结构的起始位置。也就是说，遍历器对象本质上，就是一个指针对象。
第一次调用指针对象的 next 方法，可以将指针指向数据结构的第一个成员。
第二次调用指针对象的 next 方法，指针就指向数据结构的第二个成员。
不断调用指针对象的 next 方法，直到它指向数据结构的结束位置。

每一次调用 next 方法，都会返回数据结构的当前成员的信息。

返回一个包含 value 和 done 两个属性的对象。其中， value 属性是当前成员的值， done 属性是一个布尔值，表示遍历是否结束。

function makeIterator(array) {
    var nextIndex = 0;
    return {
        next: function() {
            return nextIndex < array.length ? {
                value: array[nextIndex++],
                done: false
            } : {
                value: undefined,
                done: true
            }
        }
    }
}
let it = makeIterator(['a', 'b'])
it.next() // { value: "a", done: false } // { value: "a" }
it.next() // { value: "b", done: false } // { value: "b" }
it.next() // { value: undefined, done: true } // { done: true }

对于遍历器对象来说， done: false 和 value: undefined 属性都是可以省略的

2. 默认的 Iterator 接口

Iterator 接口的目的，就是为所有数据结构，提供了一种统一的访问机制，即 for...of 循环。当使用 for...of 循环遍历某种数据结构时，该循环会自动去寻找 Iterator 接口。

一种数据结构只要部署了 Iterator 接口，我们就称这种数据结构是”可遍历的“（iterable）。

ES6 规定，默认的 Iterator 接口部署在数据结构的 Symbol.iterator 属性，或者说，一个数据结构只要具有 Symbol.iterator 属性，就可以认为是“可遍历的”（iterable）。

Symbol.iterator 属性本身是一个函数，就是当前数据结构默认的遍历器生成函数。执行这个函数，就会返回一个遍历器。至于属性名 Symbol.iterator ，它是一个表达式，返回 Symbol 对象的 iterator 属性，这是一个预定义好的、类型为 Symbol 的特殊值，所以要放在方括号内。

// 为对象部署 Iterator 接口
const obj = {
    [Symbol.iterator]: function() {
        return {
            next: function() {
                return { value: 1, done: true };
            }
        };
    }
};

ES6 的有些数据结构原生具备 Iterator 接口（比如数组）。原因在于，这些数据结构原生部署了Symbol.iterator 属性，另外一些数据结构没有（比如对象）。凡是部署了 Symbol.iterator 属性的数据结构，就称为部署了遍历器接口。调用这个接口，就会返回一个遍历器对象。

原生具备 Iterator 接口的数据结构如下。 Array Map Set String TypedArray 函数的 arguments 对象 NodeList 对象

例子：

let arr = ['a', 'b', 'c'];
let iter = arr[Symbol.iterator]();
console.log(iter.next()); // { value: 'a', done: false }
console.log(iter.next()); // { value: 'b', done: false }
console.log(iter.next()); // { value: 'c', done: false }
console.log(iter.next()); // { value: undefined, done: true }

对象（Object）之所以没有默认部署 Iterator 接口，是因为对象的哪个属性先遍历，哪个属性后遍历是不确定的，需要开发者手动指定。本质上，遍历器是一种线性处理，对于任何非线性的数据结构，部署遍历器接口，就等于部署一种线性转换。不过，严格地说，对象部署遍历器接口并不是很必要，因为这时对象实际上被当作 Map 结构使用，ES5 没有 Map 结构，而 ES6 原生提供了。

一个对象如果要具备可被 for...of 循环调用的 Iterator 接口，就必须在 Symbol.iterator 的属性上部署遍历器生成方法（原型链上的对象具有该方法也可）。

class RangeIterator {
    constructor(start, stop) {
        this.value = start;
        this.stop = stop;
    }
    [Symbol.iterator]() { return this; }
    next() {
        var value = this.value;
        if (value < this.stop) {
            this.value++;
            return { done: false, value: value};
        }
        return { done: true, value: undefined };
    }
}

function range(start, stop) {
    return new RangeIterator(start, stop);
}
for (var value of range(0, 3)) {
    console.log(value); // 0, 1, 2
}

上面代码是一个类部署 Iterator 接口的写法。 Symbol.iterator 属性对应一个函数，执行后返回当前对象的遍历器对象。

下面是通过遍历器实现指针结构的例子。

function Obj(value) {
    this.value = value;
    this.next = null;
}
Obj.prototype[Symbol.iterator] = function() {
    var iterator = { next: next };
    var current = this;
    function next() {
        if (current) {
            var value = current.value;
            current = current.next;
            return { done: false, value: value };
        } else { 
            return { done: true };
        }
    }
    return iterator;
}
var one = new Obj(1);
var two = new Obj(2);
var three = new Obj(3);
one.next = two;
two.next = three;
for (var i of one) {
    console.log(i); // 1, 2, 3
}

上面代码首先在构造函数的原型链上部署 Symbol.iterator 方法，调用该方法会返回遍历器对象 iterator ，调用该对象的 next 方法，在返回一个值的同时，自动将内部指针移到下一个实例。

3. 调用 Iterator 接口的场合

3.1 解构赋值

对数组和 Set 结构进行解构赋值时，会默认调用 Symbol.iterator 方法。

let set = new Set().add('a').add('b').add('c');
let [x, y] = set;
console.log(x, y); // x='a'; y='b'
let [first, ...rest] = set;
console.log(first, rest); // first='a'; rest=['b','c'];

3.2 扩展运算符

扩展运算符（...）也会调用默认的 Iterator 接口。

// 例一
var str = 'hello';
console.log([...str]); // ['h','e','l','l','o']
// 例二
let arr = ['b', 'c'];
console.log(['a', ...arr, 'd']); // ['a', 'b', 'c', 'd']

实际上，这提供了一种简便机制，可以将任何部署了 Iterator 接口的数据结构，转为数组。也就是说，只要某个数据结构部署了 Iterator 接口，就可以对它使用扩展运算符，将其转为数组。

3.3 yield*

yield* 后面跟的是一个可遍历的结构，它会调用该结构的遍历器接口。

let generator = function*() {
  yield 1;
  yield*[2, 3, 4];
  yield 5;
};
var iterator = generator();
console.log(iterator.next()); // { value: 1, done: false }
console.log(iterator.next()); // { value: 2, done: false }
console.log(iterator.next()); // { value: 3, done: false }
console.log(iterator.next()); // { value: 4, done: false }
console.log(iterator.next()); // { value: 5, done: false }
console.log(iterator.next()); // {value: undefined, done: true}

3.4 其他场合

由于数组的遍历会调用遍历器接口，所以任何接受数组作为参数的场合，其实都调用了遍历器接口。

for...of Array.from() Map(), Set(), WeakMap(), WeakSet()（比如 new Map([['a',1],['b',2]]) ） Promise.all() Promise.race()

4. 字符串的 Iterator 接口

字符串是一个类似数组的对象，也原生具有 Iterator 接口。

var someString = "hi";
console.log(typeof someString[Symbol.iterator]) // function
var iterator = someString[Symbol.iterator]()
console.log(iterator.next()) // { value: "h", done: false }
console.log(iterator.next()) // { value: "i", done: false }
console.log(iterator.next()) // { value: undefined, done: true }

上面代码中，调用 Symbol.iterator 方法返回一个遍历器对象，在这个遍历器上可以调用 next 方法，实现对于字符串的遍历。可以覆盖原生的 Symbol.iterator 方法，达到修改遍历器行为的目的。

var str = new String("hi");
console.log([...str]); // ["h", "i"]
str[Symbol.iterator] = function() {
    return {
        next: function() {
            if (this._first) {
                this._first = false;
                return { value: "bye", done: false };
            } else {
                return { done: true };
            }
        },
        _first: true
    };
};
console.log([...str]); // ["bye"]
console.log(str); // "hi"

上面代码中，字符串 str 的 Symbol.iterator 方法被修改了，所以扩展运算符（ ... ）返回的值变成了 bye ，而字符串本身还是 hi 字符串的不可变性。

5. Iterator 接口与 Genderator 函数

Symbol.iterator 方法的最简单实现---Generator 函数。

  var myIterable = {};
  myIterable[Symbol.iterator] = function*() {
    yield 1;
    yield 2;
    yield 3;
  };
  console.log([...myIterable]); // [1, 2, 3]
  // 或者采用下面的简洁写法
  let obj = {
    *[Symbol.iterator]() {
      yield 'hello';
      yield 'world';
    }
  };
  for (let x of obj) {
    console.log(x); // hello world
  }

上面代码中， Symbol.iterator 方法几乎不用部署任何代码，只要用 yield 命令给出每一步的返回值即可。

6. 遍历器对象的 return()、throw()

next 方法是必须部署的， return 方法和 throw 方法是否部署是可选的。

return 方法的使用场合是，如果 for...of 循环提前退出（通常是因为出错，或者有 break 语句或 continue 语句），就会调用 return 方法。如果一个对象在完成遍历前，需要清理或释放资源，就可以部署 return 方法。

function readLinesSync(file) {
  return {
    next() {
      return { done: false };
    },
    return() {
      file.close();
      return { done: true };
    },
  };
}

上面代码中，函数 readLinesSync 接受一个文件对象作为参数，返回一个遍历器对象，其中除了 next 方法，还部署了 return 方法。下面的三种情况，都会触发执行 return 方法。

// 情况一
for (let line of readLinesSync(fileName)) {
    console.log(line);
    break;
}
// 情况二
for (let line of readLinesSync(fileName)) {
    console.log(line);
    continue;
}
// 情况三
for (let line of readLinesSync(fileName)) {
    console.log(line);
    throw new Error();
}

注意， return 方法必须返回一个对象，这是 Generator 规格决定的。 throw 方法主要是配合 Generator 函数使用，一般的遍历器对象用不到这个方法。

7. for ...of 循环

for...of 循环遍历所有数据结构的统一的方法。

一个数据结构只要部署了 Symbol.iterator 属性，就被视为具有 iterator 接口，就可以用 for...of 循环遍历它的成员。也就是说， for...of 循环内部调用的是数据结构的 Symbol.iterator 方法。 for...of 循环可以使用的范围包括数组、Set 和 Map 结构、某些类似数组的对象（比如 arguments 对象、DOM NodeList 对象）、Generator 对象，以及字符串。

7.1 数组

数组原生具备 iterator 接口（即默认部署了 Symbol.iterator 属性）， for...of 循环本质上就是调用这个接口产生的遍历器。

const arr = ['red', 'green', 'blue'];
for (let v of arr) {
    console.log(v); // red green blue
}
// 空对象 obj 部署了数组 arr 的 Symbol.iterator 属性，结果 obj 的 for...of 循环，产生了与 arr 完全一样的结果。
const obj = {};
obj[Symbol.iterator] = arr[Symbol.iterator].bind(arr);
for (let v of obj) {
    console.log(v); // red green blue
}

for...of 循环可以代替数组实例的 forEach 方法

for...in 循环和 for...of 循环相同点

JavaScript 原有的 for...in 循环，只能获得对象的键名，不能直接获取键值。ES6 提供 for...of 循环，允许遍历获得键值。

如果要通过 for...of 循环，获取数组的索引，可以借助数组实例的 entries 方法和 keys 方法

for...in 循环和 for...of 循环不同点

for...of 循环调用遍历器接口，数组的遍历器接口只返回具有数字索引的属性。这一点跟 for...in 循环也不一样。

let arr = [3, 5, 7];
arr.foo = 'hello';
for (let i in arr) {
  console.log(i); // "0", "1", "2", "foo"
}
// for...of 循环不会返回数组 arr 的 foo 属性。
for (let i of arr) {
  console.log(i); // "3", "5", "7"
}

7.2 Set 和 Map 结构

Set 和 Map 结构也原生具有 Iterator 接口，可以直接使用 for...of 循环。

var engines = new Set(["Gecko", "Trident", "Webkit", "Webkit"]);
for (var e of engines) {
    console.log(e);
}
// Gecko
// Trident
// Webkit
var es6 = new Map();
es6.set("edition", 6);
es6.set("committee", "TC39");
es6.set("standard", "ECMA-262");
for (var [name, value] of es6) {
    console.log(name + ": " + value);
}
// edition: 6
// committee: TC39
// standard: ECMA-262

遍历 Set 结构和 Map 结构。值得注意的地方有两个:

首先，遍历的顺序是按照各个成员被添加进数据结构的顺序。

其次，Set 结构遍历时，返回的是一个值，而 Map 结构遍历时，返回的是一个数组，该数组的两个成员分别为当前 Map 成员的键名和键值。

let map = new Map().set('a', 1).set('b', 2);
for (let pair of map) {
    console.log(pair);
}
// ['a', 1]
// ['b', 2]
for (let [key, value] of map) {
    console.log(key + ' : ' + value);
}
// a : 1
// b : 2

7.3 计算生成的数据结构

有些数据结构是在现有数据结构的基础上，计算生成的。比如，ES6 的数组、Set、Map 都部署了以下三个方法，调用后都返回遍历器对象。

entries() 返回一个遍历器对象，用来遍历 [键名, 键值] 组成的数组。对于数组，键名就是索引值；对于 Set，键名与键值相同。Map 结构的 Iterator 接口，默认就是调用 entries 方法。
keys() 返回一个遍历器对象，用来遍历所有的键名。
values() 返回一个遍历器对象，用来遍历所有的键值。

这三个方法调用后生成的遍历器对象，所遍历的都是计算生成的数据结构。

let arr = ['a', 'b', 'c'];
for (let pair of arr.entries()) {
    console.log(pair);
}
// [0, 'a']
// [1, 'b']
// [2, 'c']

7.4 类似数组的对象

类似数组的对象包括好几类。下面是 for...of 循环用于字符串、DOM NodeList 对象、 arguments 对象的例子。

// 字符串
let str = "hello";
for (let s of str) {
  console.log(s); // h e l l o
}
// DOM NodeList对象
let paras = document.querySelectorAll("p");
for (let p of paras) {
  p.classList.add("test");
}
// arguments对象
function printArgs() {
  for (let x of arguments) {
    console.log(x);
  }
}
printArgs('a', 'b');
// 'a'
// 'b'

对于字符串来说， for...of 循环还有一个特点，就是会正确识别 32 位 UTF-16 字符。

for (let x of 'a\uD83D\uDC0A') {
 console.log(x);
}
// 'a'
// '\uD83D\uDC0A'

并不是所有类似数组的对象都具有 Iterator 接口，一个简便的解决方法，就是使用 Array.from 方法将其转为数组。

let arrayLike = {
    length: 2,
    0: 'a',
    1: 'b'
};
// 报错
for (let x of arrayLike) {
    console.log(x);
}
// 正确
for (let x of Array.from(arrayLike)) {
    console.log(x);
}

7.5 对象

对于普通的对象， for...of 结构不能直接使用，会报错，必须部署了 Iterator 接口后才能使用。但是，这样情况下，for...in 循环依然可以用来遍历键名。

对于普通的对象， for...in 循环可以遍历键名， for...of 循环会报错。

一种解决方法是，使用 Object.keys 方法将对象的键名生成一个数组，然后遍历这个数组。

for (var key of Object.keys(someObject)) {
 console.log(key + ': ' + someObject[key]);
}

另一个方法是使用 Generator 函数将对象重新包装一下。

function* entries(obj) {
 for (let key of Object.keys(obj)) {
 yield [key, obj[key]];
 }
}
for (let [key, value] of entries(obj)) {
 console.log(key, '->', value);
}
// a -> 1
// b -> 2
// c -> 3

7.6 与其他遍历语法比较

以数组为例，JavaScript 提供多种遍历语法。最原始的写法就是 for 循环。

for (var index = 0; index < myArray.length; index++) {
 console.log(myArray[index]);
}

这种写法比较麻烦，因此数组提供内置的 forEach 方法。

myArray.forEach(function (value) {
 console.log(value);
})

这种写法的问题在于，无法中途跳出 forEach 循环， break 命令或 return 命令都不能奏效。

for...in 循环可以遍历数组的键名。

for (var index in myArray) {
 console.log(myArray[index]);
}

for...in 循环有几个缺点:

数组的键名是数字，但是 for...in 循环是以字符串作为键名“0”、“1”、“2”等等。
for...in 循环不仅遍历数字键名，还会遍历手动添加的其他键，甚至包括原型链上的键。
某些情况下， for...in 循环会以任意顺序遍历键名。

总之， for...in 循环主要是为遍历对象而设计的，不适用于遍历数组。

for...of 循环相比上面几种做法，有一些显著的优点。

for (let value of myArray) {
 console.log(value);
}

有着同 for...in 一样的简洁语法，但是没有 for...in 那些缺点。
不同于 forEach 方法，它可以与 break 、 continue 和 return 配合使用。
提供了遍历所有数据结构的统一操作接口。

使用 break 语句，跳出 for...of 循环：

for (var n of fibonacci) {
 if (n > 1000)s
 break;
 console.log(n);
}

上面的例子，会输出斐波纳契数列小于等于 1000 的项。如果当前项大于 1000，就会使用 break 语句跳出 for...of 循环。

Iterator 和 for...of 循环

1. Iterator 的概念​

2. 默认的 Iterator 接口​

3. 调用 Iterator 接口的场合​

3.1 解构赋值​

3.2 扩展运算符​

3.3 yield*​

3.4 其他场合​

4. 字符串的 Iterator 接口​

5. Iterator 接口与 Genderator 函数​

6. 遍历器对象的 return()、throw()​

7. for ...of 循环​

7.1 数组​

for...in 循环 和 for...of 循环 相同点​

for...in 循环 和 for...of 循环 不同点​

7.2 Set 和 Map 结构​

7.3 计算生成的数据结构​

7.4 类似数组的对象​

7.5 对象​

7.6 与其他遍历语法比较​